api/zones/{id} (Get)

Get	api/zones/{id}

In This Topic

Resource Path: /sites/{company-id}/api/zones/{id}

Uri: https://secure.ontime360.com/sites/{company-id}/api/zones/{id}

Summary

Retrieves a single Zone object assigned to a given identifier.

Parameters

Name	Description	Data Type
id (path)	The unique identifier of a Zone as a Guid.	string

200 Response

The response body is of type Zone.

Returns a comprehensive Zone object.

Overview

Zone

Represents a comprehensive Zone record within the OnTime API.

ID : string

The unique identifier for this Zone record.

Name : string

The name of this Zone.

PostalCodes : string

The postal codes assigned to this Zone.

Cities : string

A list of comma-separated cities that this zone is associated with.

PolygonPoints : string

A list of comma-separated latitude/longitude coordinates where each pairing is separated by a pipe character '|'. These coordinates represent the geographical boundary of this Zone, and can be drawn on a map.

Fault Responses

Fault	Description
400	Request was improperly formatted, contained invalid data, or contained incorrect values. See response body for more information.
401	Authorization key is invalid or no longer exists.
403	Authorization key does not have permission to perform this action, or does not have permission to access the requested data. See response body for more information.